<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>spade.xmpp.roster.Roster</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="spade-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="spade-module.html">Package&nbsp;spade</a> ::
        <a href="spade.xmpp-module.html">Package&nbsp;xmpp</a> ::
        <a href="spade.xmpp.roster-module.html">Module&nbsp;roster</a> ::
        Class&nbsp;Roster
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="spade.xmpp.roster.Roster-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Roster</h1><p class="nomargin-top"><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster">source&nbsp;code</a></span></p>
<pre class="base-tree">
<a href="spade.xmpp.client.PlugIn-class.html">client.PlugIn</a> --+
                |
               <strong class="uidshort">Roster</strong>
</pre>

<hr />
<p>Defines a plenty of methods that will allow you to manage roster. Also
  automatically track presences from remote JIDs taking into account that 
  every JID can have multiple resources connected. Does not currently 
  support 'error' presences. You can also use mapping interface for access 
  to the internal representation of contacts in roster.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Init internal variables.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#plugin" class="summary-sig-name">plugin</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">owner</span>,
        <span class="summary-sig-arg">request</span>=<span class="summary-sig-default">1</span>)</span><br />
      Register presence and subscription trackers in the owner's 
      dispatcher.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.plugin">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="Request"></a><span class="summary-sig-name">Request</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">force</span>=<span class="summary-sig-default">0</span>)</span><br />
      Request roster from server if it were not yet requested (or if the 
      'force' argument is set).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.Request">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getRoster"></a><span class="summary-sig-name">getRoster</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Requests roster from server if neccessary and returns self.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getRoster">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#RosterIqHandler" class="summary-sig-name">RosterIqHandler</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">dis</span>,
        <span class="summary-sig-arg">stanza</span>)</span><br />
      Subscription tracker.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.RosterIqHandler">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#PresenceHandler" class="summary-sig-name">PresenceHandler</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">dis</span>,
        <span class="summary-sig-arg">pres</span>)</span><br />
      Presence tracker.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.PresenceHandler">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#_getItemData" class="summary-sig-name" onclick="show_private();">_getItemData</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>,
        <span class="summary-sig-arg">dataname</span>)</span><br />
      Return specific jid's representation in internal format.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster._getItemData">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#_getResourceData" class="summary-sig-name" onclick="show_private();">_getResourceData</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>,
        <span class="summary-sig-arg">dataname</span>)</span><br />
      Return specific jid's resource representation in internal format.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster._getResourceData">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="delItem"></a><span class="summary-sig-name">delItem</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Delete contact 'jid' from roster.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.delItem">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getAsk"></a><span class="summary-sig-name">getAsk</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Returns 'ask' value of contact 'jid'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getAsk">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getGroups"></a><span class="summary-sig-name">getGroups</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Returns groups list that contact 'jid' belongs to.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getGroups">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getName"></a><span class="summary-sig-name">getName</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Returns name of contact 'jid'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getName">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#getPriority" class="summary-sig-name">getPriority</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Returns priority of contact 'jid'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getPriority">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getRawRoster"></a><span class="summary-sig-name">getRawRoster</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns roster representation in internal format.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getRawRoster">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getRawItem"></a><span class="summary-sig-name">getRawItem</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Returns roster item 'jid' representation in internal format.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getRawItem">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#getShow" class="summary-sig-name">getShow</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Returns 'show' value of contact 'jid'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getShow">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#getStatus" class="summary-sig-name">getStatus</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Returns 'status' value of contact 'jid'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getStatus">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getSubscription"></a><span class="summary-sig-name">getSubscription</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Returns 'subscription' value of contact 'jid'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getSubscription">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getResources"></a><span class="summary-sig-name">getResources</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Returns list of connected resources of contact 'jid'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getResources">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="setItem"></a><span class="summary-sig-name">setItem</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>,
        <span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">groups</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>)</span><br />
      Creates/renames contact 'jid' and sets the groups list that it now 
      belongs to.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.setItem">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getItems"></a><span class="summary-sig-name">getItems</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Return list of all [bare] JIDs that the roster is currently tracks.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getItems">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#keys" class="summary-sig-name">keys</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Same as getItems.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.keys">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">item</span>)</span><br />
      Get the contact in the internal format.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.__getitem__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getItem"></a><span class="summary-sig-name">getItem</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">item</span>)</span><br />
      Get the contact in the internal format (or None if JID 'item' is not 
      in roster).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getItem">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="Subscribe"></a><span class="summary-sig-name">Subscribe</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Send subscription request to JID 'jid'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.Subscribe">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="Unsubscribe"></a><span class="summary-sig-name">Unsubscribe</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Ask for removing our subscription for JID 'jid'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.Unsubscribe">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#Authorize" class="summary-sig-name">Authorize</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Authorise JID 'jid'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.Authorize">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.roster.Roster-class.html#Unauthorize" class="summary-sig-name">Unauthorize</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>)</span><br />
      Unauthorise JID 'jid'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.Unauthorize">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="spade.xmpp.client.PlugIn-class.html">client.PlugIn</a></code></b>:
      <code><a href="spade.xmpp.client.PlugIn-class.html#DEBUG">DEBUG</a></code>,
      <code><a href="spade.xmpp.client.PlugIn-class.html#PlugIn">PlugIn</a></code>,
      <code><a href="spade.xmpp.client.PlugIn-class.html#PlugOut">PlugOut</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Init internal variables.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="spade.xmpp.client.PlugIn-class.html#__init__">client.PlugIn.__init__</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="plugin"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">plugin</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">owner</span>,
        <span class="sig-arg">request</span>=<span class="sig-default">1</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.plugin">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Register presence and subscription trackers in the owner's dispatcher.
  Also request roster from server if the 'request' argument is set. Used 
  internally.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="RosterIqHandler"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">RosterIqHandler</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">dis</span>,
        <span class="sig-arg">stanza</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.RosterIqHandler">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Subscription tracker. Used internally for setting items state in 
  internal roster representation.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="PresenceHandler"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">PresenceHandler</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">dis</span>,
        <span class="sig-arg">pres</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.PresenceHandler">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Presence tracker. Used internally for setting items' resources state 
  in internal roster representation.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="_getItemData"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_getItemData</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">jid</span>,
        <span class="sig-arg">dataname</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster._getItemData">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Return specific jid's representation in internal format. Used 
  internally.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="_getResourceData"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_getResourceData</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">jid</span>,
        <span class="sig-arg">dataname</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster._getResourceData">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Return specific jid's resource representation in internal format. Used
  internally.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getPriority"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getPriority</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">jid</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getPriority">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns priority of contact 'jid'. 'jid' should be a full (not bare) 
  JID.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getShow"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getShow</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">jid</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getShow">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns 'show' value of contact 'jid'. 'jid' should be a full (not 
  bare) JID.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getStatus"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getStatus</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">jid</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.getStatus">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns 'status' value of contact 'jid'. 'jid' should be a full (not 
  bare) JID.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="keys"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">keys</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.keys">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Same as getItems. Provided for the sake of dictionary interface.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="__getitem__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__getitem__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">item</span>)</span>
    <br /><em class="fname">(Indexing operator)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.__getitem__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Get the contact in the internal format. Raises KeyError if JID 'item' 
  is not in roster.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="Authorize"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Authorize</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">jid</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.Authorize">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Authorise JID 'jid'. Works only if these JID requested auth 
  previously.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="Unauthorize"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Unauthorize</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">jid</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.roster-pysrc.html#Roster.Unauthorize">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Unauthorise JID 'jid'. Use for declining authorisation request or for 
  removing existing authorization.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="spade-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed May 26 16:26:24 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
